XR API 2.4
Loading...
Searching...
No Matches
Classes | Typedefs | Functions | Variables
sony::oz::xr_runtime::utility Namespace Reference

Classes

struct  Library
 

Typedefs

using sony_ozGetDeviceNum_t = SonyOzResult (*)(SonyOzPlatformId, uint64_t*)
 
using sony_ozEnumerateDevices_t
 
using sony_ozSetDebugLogCallback_t
 
using sony_ozCreateSession_t
 
using sony_ozDestroySession_t = SonyOzResult (*)(SonyOzSessionHandle*)
 
using sony_ozBeginSession_t = SonyOzResult (*)(SonyOzSessionHandle)
 
using sony_ozEndSession_t = SonyOzResult (*)(SonyOzSessionHandle)
 
using sony_ozGetSessionState_t
 
using sony_ozUpdateTrackingResultCache_t
 
using sony_ozGetCachedPose_t
 
using sony_ozGetProjection_t
 
using sony_ozSubmitD3d11_t
 
using sony_ozSubmitD3d12_t
 
using sony_ozSubmitOpengl_t
 
using sony_ozSubmitMultiPassD3d11_t
 
using sony_ozSubmitMultiPassD3d12_t
 
using sony_ozSubmitMultiPassOpengl_t
 
using sony_ozEnableStereo_t = SonyOzResult (*)(SonyOzSessionHandle, bool)
 
using sony_ozSetColorSpace_t
 
using sony_ozGetTargetMonitorRectangle_t
 
using sony_ozGetDisplaySpec_t
 
using sony_ozGetXrSystemError_t
 
using sony_ozGetXrSystemErrorNum_t
 
using sony_ozGetXrSystemErrorList_t
 

Functions

std::pair< bool, std::wstring > ValidateLibraryVesion (SonyOzPlatformId platform_id, DWORD version[VERSION_SIZE])
 
std::unique_ptr< Library > LinkXrLibraryWin64 (SonyOzPlatformId platform_id)
 
void UnlinkXrLibraryWin64 ()
 
bool WaitUntilRunningState (SonyOzSessionHandle handle)
 Wait until the session is available.
 

Variables

constexpr uint32_t VERSION_SIZE {4}
 

Typedef Documentation

◆ sony_ozBeginSession_t

using sony::oz::xr_runtime::utility::sony_ozBeginSession_t = SonyOzResult (*)(SonyOzSessionHandle)

◆ sony_ozCreateSession_t

using sony::oz::xr_runtime::utility::sony_ozCreateSession_t
Initial value:
SonyOzResult (*)(SonyOzPlatformId,
const SonyOzDeviceInfo*,
RUNTIME_OPTION_BIT_FLAG,
PLATFORM_OPTION_BIT_FLAG,
SonyOzSessionHandle*)
SonyOzDeviceInfo
Device information.
Definition xr_api_defs.h:132
SonyOzPlatformId
const char * SonyOzPlatformId
ID indicating XR platform. It will always be "Spatial Reality Display".
Definition xr_api_defs.h:93
SonyOzResult
SonyOzResult
Result of XR Runtime API.
Definition xr_api_defs.h:62
PLATFORM_OPTION_BIT_FLAG
uint8_t PLATFORM_OPTION_BIT_FLAG
Definition xr_platform_option.h:24
RUNTIME_OPTION_BIT_FLAG
uint8_t RUNTIME_OPTION_BIT_FLAG
Definition xr_runtime_option.h:24

◆ sony_ozDestroySession_t

using sony::oz::xr_runtime::utility::sony_ozDestroySession_t = SonyOzResult (*)(SonyOzSessionHandle*)

◆ sony_ozEnableStereo_t

using sony::oz::xr_runtime::utility::sony_ozEnableStereo_t = SonyOzResult (*)(SonyOzSessionHandle, bool)

◆ sony_ozEndSession_t

using sony::oz::xr_runtime::utility::sony_ozEndSession_t = SonyOzResult (*)(SonyOzSessionHandle)

◆ sony_ozEnumerateDevices_t

using sony::oz::xr_runtime::utility::sony_ozEnumerateDevices_t
Initial value:
SonyOzResult (*)(SonyOzPlatformId, uint64_t,
SonyOzDeviceInfo*)

◆ sony_ozGetCachedPose_t

using sony::oz::xr_runtime::utility::sony_ozGetCachedPose_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzPoseId, SonyOzPosef*,
bool*)
SonyOzPosef
pose(position, orientation)
Definition xr_api_defs.h:279
SonyOzPoseId
SonyOzPoseId
Definition xr_api_defs.h:445

◆ sony_ozGetDeviceNum_t

using sony::oz::xr_runtime::utility::sony_ozGetDeviceNum_t = SonyOzResult (*)(SonyOzPlatformId, uint64_t*)

◆ sony_ozGetDisplaySpec_t

using sony::oz::xr_runtime::utility::sony_ozGetDisplaySpec_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzDisplaySpec*)
SonyOzDisplaySpec
Display information.
Definition xr_api_defs.h:391

◆ sony_ozGetProjection_t

using sony::oz::xr_runtime::utility::sony_ozGetProjection_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzPoseId,
SonyOzProjection*)
SonyOzProjection
Definition xr_api_defs.h:451

◆ sony_ozGetSessionState_t

using sony::oz::xr_runtime::utility::sony_ozGetSessionState_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzSessionState*)
SonyOzSessionState
SonyOzSessionState
session state
Definition xr_api_defs.h:99

◆ sony_ozGetTargetMonitorRectangle_t

using sony::oz::xr_runtime::utility::sony_ozGetTargetMonitorRectangle_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzRect*)
SonyOzRect
Rectangle.
Definition xr_api_defs.h:112

◆ sony_ozGetXrSystemError_t

using sony::oz::xr_runtime::utility::sony_ozGetXrSystemError_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
SonyOzXrSystemError*)
SonyOzXrSystemError
Sytem error occurred in XR Runtime.
Definition xr_api_defs.h:432

◆ sony_ozGetXrSystemErrorList_t

using sony::oz::xr_runtime::utility::sony_ozGetXrSystemErrorList_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
uint16_t,
SonyOzXrSystemError*)

◆ sony_ozGetXrSystemErrorNum_t

using sony::oz::xr_runtime::utility::sony_ozGetXrSystemErrorNum_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
uint16_t*)

◆ sony_ozSetColorSpace_t

using sony::oz::xr_runtime::utility::sony_ozSetColorSpace_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle, int, int,
float)

◆ sony_ozSetDebugLogCallback_t

using sony::oz::xr_runtime::utility::sony_ozSetDebugLogCallback_t
Initial value:
SonyOzResult (*)(SonyOzPlatformId, SonyOzLogSettings_LogCallback)
SonyOzLogSettings_LogCallback
void(*)(const char *, SonyOzLogSettings_LogLevels) SonyOzLogSettings_LogCallback
Definition log_defs.h:33

◆ sony_ozSubmitD3d11_t

using sony::oz::xr_runtime::utility::sony_ozSubmitD3d11_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
ID3D11Device*, ID3D11Texture2D*,
bool, ID3D11Texture2D*)

◆ sony_ozSubmitD3d12_t

using sony::oz::xr_runtime::utility::sony_ozSubmitD3d12_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
ID3D12CommandQueue*, uint32_t,
ID3D12Resource*, bool,
DXGI_FORMAT, ID3D12Resource*)
DXGI_FORMAT
DXGI_FORMAT
Definition xr_api_defs.h:469

◆ sony_ozSubmitMultiPassD3d11_t

using sony::oz::xr_runtime::utility::sony_ozSubmitMultiPassD3d11_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
ID3D11Device*,
ID3D11Texture2D*,
ID3D11Texture2D*, bool,
ID3D11Texture2D*)

◆ sony_ozSubmitMultiPassD3d12_t

using sony::oz::xr_runtime::utility::sony_ozSubmitMultiPassD3d12_t
Initial value:
SonyOzResult (*)(
SonyOzSessionHandle, ID3D12CommandQueue*, uint32_t, ID3D12Resource*,
ID3D12Resource*, bool, DXGI_FORMAT, ID3D12Resource*)

◆ sony_ozSubmitMultiPassOpengl_t

using sony::oz::xr_runtime::utility::sony_ozSubmitMultiPassOpengl_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
unsigned int,
unsigned int, bool,
unsigned int)

◆ sony_ozSubmitOpengl_t

using sony::oz::xr_runtime::utility::sony_ozSubmitOpengl_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle,
unsigned int, bool,
unsigned int)

◆ sony_ozUpdateTrackingResultCache_t

using sony::oz::xr_runtime::utility::sony_ozUpdateTrackingResultCache_t
Initial value:
SonyOzResult (*)(SonyOzSessionHandle)

Function Documentation

◆ LinkXrLibraryWin64()

std::unique_ptr< Library > sony::oz::xr_runtime::utility::LinkXrLibraryWin64 ( SonyOzPlatformId platform_id)

◆ UnlinkXrLibraryWin64()

void sony::oz::xr_runtime::utility::UnlinkXrLibraryWin64 ( )

◆ ValidateLibraryVesion()

std::pair< bool, std::wstring > sony::oz::xr_runtime::utility::ValidateLibraryVesion ( SonyOzPlatformId platform_id,
DWORD version[VERSION_SIZE] )

◆ WaitUntilRunningState()

bool sony::oz::xr_runtime::utility::WaitUntilRunningState ( SonyOzSessionHandle handle)

Wait until the session is available.

Parameters
[in]sessionPass the session handle.
Returns
True is returned when the session is available. If the session is not available, false is returned.

After calling BeginSession(), you must wait until it becomes available.

Attention

Variable Documentation

◆ VERSION_SIZE

uint32_t sony::oz::xr_runtime::utility::VERSION_SIZE {4}
constexpr
Generated by doxygen 1.12.0